Server Refactor by anantmittal · Pull Request #91 · uw-ssec/respondent-driven-sampling

anantmittal · 2025-10-20T22:53:41Z

No description provided.

* chore: create new folder structure with placeholders * chore: move db connection into database layer * docs: update filetree * chore: minor updates to readme and deduplicate db tests * chore: rename repos to controllers

* chore: set up utils * feat: implement survey model * feat: implement zod validators * feat: implement model agnostic operations * feat: implement survey controllers * chore: temporarily migrate to 'v2' routes * feat: simplify model and add more middleware * feat: add child code generate retries if not unique * chore: streamline zod schema * chore: update test suite to match db constraints * chore: update constants * feat: enforce immutability * chore: update errors * chore: update controllers * feat: ensure children of _SEED_ are not present elsewhere * chore: update zod schema * chore: update tests * chore: update err propagation * docs: add swagger comments * fix: update referral code generator to current constraints * chore: update uniqueness constraint * fix: resolve collision errors * chore: fix comment accuracy * fix: rm unnecessary lines * chore: code review - added REVIEW comments - moved db connection to index.ts - deleted connection folder * chore: folder + middleware refactor for survey * chore: refactor TODO table folders * chore: fix outdated test suite * docs: update filetree diagram * review: Minor refactor after code review * chore: add code uniqueness validation during generation --------- Co-authored-by: Anant Mittal <anmittal@uw.edu>

* fix: async helper functions * chore: referral code -> survey code

* feat: seed mongoose module * feat: seed zod module * feat: seed routes * docs: add swagger comments * feat: location module + migrate location dependencies * chore: update test suites * feat: integrate Location routes * feat: user module * refactor: shared hooks * feat: integrate v2 user routes * chore: flatten user schema, prettify import statements, leave notes for future * chore: minor backwards compatability fixes

…ilures

feat: Incorporate new RBAC rules

Copilot

Pull Request Overview

This PR implements a comprehensive refactoring to establish a v2 API architecture with improved permissions, database models, and validation. The changes introduce:

Migration from employeeId to userObjectId throughout the codebase
New v2 routes with permission-based access control using CASL
Database layer restructuring with Mongoose models and Zod validation for User, Survey, Seed, and Location domains
TypeScript path alias updates from relative baseUrl to explicit path mapping
Removal of deprecated v1 utilities and models

Reviewed Changes

Copilot reviewed 58 out of 61 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
server/tsconfig.json	Updated TypeScript path mapping from baseUrl to explicit paths configuration
server/src/utils/authTokenHandler.ts	Refactored to use `userObjectId` instead of `employeeId` with typed JWT payload
server/src/types/auth.ts	Updated auth types to use `userObjectId` and added `locationObjectId`
server/src/types/models.ts	Marked for deprecation, updated import paths to new permissions structure
server/src/routes/v2/*.ts	New v2 API routes with CASL-based permissions for users, surveys, seeds, locations
server/src/routes/v1/*.ts	Legacy routes commented out or updated with new permission imports
server/src/permissions/*.ts	New permission system with constants, ability builder, and utility functions
server/src/middleware/auth.ts	Enhanced with permission building and latest location derivation
server/src/middleware/validate.ts	New Zod-based validation middleware
server/src/database//mongoose/.ts	New Mongoose models with hooks for User, Survey, Seed, Location
server/src/database//zod/.ts	Zod validation schemas for all database models
server/src/database/utils/*.ts	Shared error codes, constants, and validation hooks
server/src/index.ts	Updated with v2 routes, Swagger setup, and top-level await for DB connection
server/package.json	Added dependencies: zod, swagger-jsdoc, swagger-ui-express
client/src/pages/Signup/Signup.tsx	Updated to fetch locations and use new role enum values

Files not reviewed (1)

server/package-lock.json: Language not supported

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

server/src/database/location/zod/location.base.ts

server/src/database/user/zod/user.base.ts

server/src/middleware/auth.ts

server/src/index.ts

server/src/database/survey/mongoose/__tests__/survey.model.test.ts

server/src/permissions/__tests__/abilityBuilder.test.ts

Copilot

Pull Request Overview

Copilot reviewed 59 out of 62 changed files in this pull request and generated 5 comments.

Files not reviewed (1)

server/package-lock.json: Language not supported

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-10-29T20:45:09Z

server/src/middleware/auth.ts

+		if (!req.authorization) {
+			res.sendStatus(403);
+			return;
+		}


The condition !req.authorization will always be false since defineAbilitiesForUser always returns an Ability object (never null or undefined). This check is unnecessary and misleading—remove it or verify that the function can actually return a falsy value.

Copilot · 2025-10-29T20:45:09Z

server/src/database/location/zod/location.base.ts

+	hubType: z.enum(HubType),
+	locationType: z.enum(LocationType),


Using z.enum(HubType) and z.enum(LocationType) is incorrect. These are TypeScript enums, not string literal tuples. Use z.nativeEnum(HubType) and z.nativeEnum(LocationType) instead.

Suggested change

hubType: z.enum(HubType),

locationType: z.enum(LocationType),

hubType: z.nativeEnum(HubType),

locationType: z.nativeEnum(LocationType),

Copilot · 2025-10-29T20:45:09Z

server/src/database/survey/zod/survey.base.ts

+		surveyCode: z
+			.string()
+			.length(
+				SURVEY_CODE_LENGTH,
+				`Survey code must be exactly ${SURVEY_CODE_LENGTH} characters`
+			),


The error message references SURVEY_CODE_LENGTH which is imported as 8, but the test data in survey.zod.test.ts line 15 uses surveyCode: '123456' (6 characters). This indicates either the constant value is wrong or the test data is incorrect, leading to validation failures.

Copilot · 2025-10-29T20:45:10Z

server/src/index.ts

 	res.sendFile(path.join(clientBuildPath, 'index.html'));
 });

+console.log(process.env.NODE_ENV);


Debug console.log statement left in production code. Remove this line or replace with proper logging.

Copilot · 2025-10-29T20:45:10Z

server/src/permissions/__tests__/abilityBuilder.test.ts

+import { subject } from '@casl/ability';
+import { describe, expect, jest, test } from '@jest/globals';
+
+import { AuthenticatedRequest } from '../../types/auth';


Unused import AuthenticatedRequest.

natalierobbins and others added 11 commits October 10, 2025 13:49

refactor: isolate database logic and models (#86)

27b806b

* chore: create new folder structure with placeholders * chore: move db connection into database layer * docs: update filetree * chore: minor updates to readme and deduplicate db tests * chore: rename repos to controllers

fix: make surveyCode uniqueness checks async (#94)

28e03dd

* fix: async helper functions * chore: referral code -> survey code

feat: define new RBAC rules in CASL

ae11dc6

chore: update auth middleware to support new RBAC rules

5b56835

chore: update routes to use new RBAC rules

081ba92

fix: remove default values from zod validators to avoid permission fa…

b785c4a

…ilures

chore: update race-condition and nullish op lints

11f9556

chore: add test suite

7f3b15c

fix: investigate endpoint debug

2abd762

anantmittal mentioned this pull request Oct 28, 2025

[Feature]: Source of approval for volunteer registration #58

Closed

1 task

natalierobbins and others added 11 commits October 29, 2025 01:05

chore: update constants

74c9cd2

chore: update custom permissions

272af08

refactor: rm sparse utils file

07f5a74

fix: delayed auth rejection for custom permissions

c0a98cc

feat: add super admin + incorporate into seed/loc routes

2ab6704

refactor: type jwt payload

b7ff7fd

refactor: add todo to old models file

bf563ea

fix: update user signup to match new schemas

177eb78

refactor: send user role to ability builder directly

1a3e61f

refactor: minor type edits

6516767

Merge pull request #98 from natalierobbins/feat/expanded-rbac

8d236cc

feat: Incorporate new RBAC rules

anantmittal marked this pull request as ready for review October 29, 2025 20:20

feat: udpate survey code generation (#99)

591fe03

anantmittal requested review from Copilot and natalierobbins October 29, 2025 20:23

anantmittal self-assigned this Oct 29, 2025

Copilot AI reviewed Oct 29, 2025

View reviewed changes

fix: copilot reviews

38c4449

anantmittal and others added 2 commits October 29, 2025 13:34

Merge branch 'feat/expanded-rbac' into server-refactor

ab4d580

chore: compound index for latest survey by user

1342e94

anantmittal requested a review from Copilot October 29, 2025 20:42

anantmittal merged commit 030c161 into main Oct 29, 2025
6 of 9 checks passed

anantmittal deleted the server-refactor branch October 29, 2025 20:45

Copilot AI reviewed Oct 29, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Server Refactor#91

Server Refactor#91
anantmittal merged 26 commits intomainfrom
server-refactor

anantmittal commented Oct 20, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Oct 29, 2025

Uh oh!

Copilot AI Oct 29, 2025

Uh oh!

Copilot AI Oct 29, 2025

Uh oh!

Copilot AI Oct 29, 2025

Uh oh!

Copilot AI Oct 29, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		hubType: z.enum(HubType),
		locationType: z.enum(LocationType),

Conversation

anantmittal commented Oct 20, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 29, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants